docs: add devnote for evaluation replace by memadi-nv · Pull Request #239 · NVIDIA-NeMo/Anonymizer

memadi-nv · 2026-08-07T00:12:33Z

Summary

Adds a developer note explaining Replace-mode evaluation, its strategy-specific scores, output columns, usage examples, and display_record() report. Includes a report screenshot.

Type of Change

Contributor Checklist

PR title follows Conventional Commits, for example fix: handle empty entity list
Related issue is linked, or a maintainer-owned no-issue reason is documented above
For non-trivial changes, a plan document is linked above, or the no-plan reason is documented above
Public API impact checked; skills/anonymizer/SKILL.md updated if needed
No real PII added to tests, docs, notebooks, fixtures, or artifacts
No API keys, service tokens, private keys, credentials, or real endpoint secrets added

Validation

Commands run:
Skipped checks or known failures:

Documentation and Artifacts

Docs updated, or not needed
If docs changed: make docs-build passes locally
If tutorial sources changed: notebooks regenerated with make convert-notebooks
If e2e, benchmark, or model-provider behavior changed: relevant validation is listed above

Signed-off-by: memadi <memadi@nvidia.com>

greptile-apps · 2026-08-07T00:14:41Z

Greptile Summary

The PR adds a developer note describing Replace-mode evaluation and its strategy-specific reporting.

Documents saving and reevaluating complete anonymization results.
Explains entity coverage, optional detection validity, and Substitute-only quality scores.
Adds report imagery, author metadata, table styling, and site navigation.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename	Overview
docs/devnotes/posts/evaluation-anonymizer-replace.md	Adds the Replace evaluation developer note; the previously questioned entity-coverage and detection-validity APIs match current HEAD.
docs/css/style.css	Prevents evaluation output-column identifiers from wrapping in the new documentation tables.
mkdocs.yml	Adds the new developer note to the documentation navigation.
docs/devnotes/.authors.yml	Registers the developer note author metadata.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart LR
    A[Replace result] --> B[Anonymizer.evaluate]
    B --> C[Entity coverage]
    B --> D[Optional detection validity]
    B --> E[Substitute quality judges]
    C --> F[DataFrame and display_record report]
    D --> F
    E --> F

_{Reviews (8): Last reviewed commit: "prevent output column names from wrappin..." | Re-trigger Greptile}

…vnote

Signed-off-by: memadi <memadi@nvidia.com>

lipikaramaswamy

Looks good! I assume the image and page render correctly when you run the docs locally with make docs-serve or make docs-build?

Signed-off-by: memadi <memadi@nvidia.com>

memadi-nv · 2026-08-10T20:00:52Z

Looks good! I assume the image and page render correctly when you run the docs locally with make docs-serve or make docs-build?

confirmed. This has been reviewed locally with make docs-serve.
Update: I noticed that some table column names were wrapping across lines. This commit keeps them on a single line.

Signed-off-by: memadi <memadi@nvidia.com>

…vnote

Signed-off-by: memadi <memadi@nvidia.com>

memadi-nv added 4 commits August 4, 2026 11:58

add author

e60d9bc

Signed-off-by: memadi <memadi@nvidia.com>

nit

c01b6b6

Signed-off-by: memadi <memadi@nvidia.com>

update devnote-nit

3b015a9

Signed-off-by: memadi <memadi@nvidia.com>

nit

29f61b4

Signed-off-by: memadi <memadi@nvidia.com>

memadi-nv requested review from alexahaushalter, asteier2026 and lipikaramaswamy August 7, 2026 00:12

memadi-nv requested review from a team as code owners August 7, 2026 00:12

memadi-nv changed the title ~~Memadi/docs/evaluation anonymizer replace devnote~~ docs: add devnote for evaluation replace Aug 7, 2026

greptile-apps Bot reviewed Aug 7, 2026

View reviewed changes

Comment thread docs/devnotes/posts/evaluation-anonymizer-replace.md

Comment thread docs/devnotes/posts/evaluation-anonymizer-replace.md

Merge branch 'main' into memadi/docs/evaluation-anonymizer-replace-de…

aefb908

…vnote

lipikaramaswamy reviewed Aug 10, 2026

View reviewed changes

Comment thread docs/devnotes/posts/evaluation-anonymizer-replace.md Outdated